API docs by Redocly

Financial Aid (1.0)

Download OpenAPI specification:Download

Anthology, Inc.: support@anthology.com URL: https://www.anthology.com

All API calls related to Financial Aid.

StudentAward

Approve Batch Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-approvebatchdisbursement-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Approve Packaged Aid

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-approvepackagedaid-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Approve Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autoapprovedisbursement-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autoaward-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Package

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autopackage-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Award Letters

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-awardletters-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Import Upload File

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineimportuploadfile-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Process Export

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineprocessexport-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Process Export Queue

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineprocessexportqueue-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Validate Import

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlinevalidateimport-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Student Award

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Approve Disbursements Batch

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-createapprovedisbursementsbatch-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create New Award Default Values

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-createnewawarddefaultvalues-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-delete-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Approve Disbursements Batch

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-deleteapprovedisbursementsbatch-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Award Student Payment

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-deletestudentawardstudentpayment-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-get-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Direct Loan Coa

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getdirectloancoa-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Eligibility Review Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-geteligibilityreviewdisbursement-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Gross Amount

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getgrossamount-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Loan Period Details

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getloanperioddetails-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Print Statements Selection

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getprintstatementsselection-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Award List

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getstudentawardlist-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Title IVCredit Balance Calculation

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-gettitleivcreditbalancecalculation-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Move Student Award Servicer Id

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-movestudentawardservicerid-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Override Cod Origination

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-overridecodorigination-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Post Work Study Disbursements

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-postworkstudydisbursements-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Proceed Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-proceedaward-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Reassign Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-reassignstudentaward-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Remove Disbursements

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-removedisbursements-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-save-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Disclosure Print History

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savedisclosureprinthistory-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savenew-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Print Disclosure Date

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-saveprintdisclosuredate-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Tsm Review

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savetsmreview-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Auto Approve Disbursement Batch Schedule Refunds

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerautoapprovedisbursementbatchschedulerefunds-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Add Drop

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportadddrop-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Pre Pull

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportprepull-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Weekly Extract

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportweeklyextract-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Award Information

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-updateawardinformation-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Validate Servicer Global

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-validateservicerglobal-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

DirectLoanConfigurationSetting

Get Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-getdirectloanconfigurationsetting-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-save-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-savenew-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

FaSapStatus

Create Fa Sap Status

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-delete-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-get-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-save-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-savenew-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

PellGrantConfigSetting

Get Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-getpellgrantconfigsetting-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-save-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-savenew-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

StudentAcademicYear

Calculate Budget Cost Of Attendance

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-calculatebudgetcostofattendance-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Calculate Student Academic Year Budget Info

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-calculatestudentacademicyearbudgetinfo-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Student Academic Year

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-delete-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Generate Academic Years For Enrollment

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-generateacademicyearsforenrollment-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-get-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-save-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-savenew-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Packaging Method

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearpackagingmethod-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Print Award Notice Dates

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearprintawardnoticedates-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Terms To Package Direct Loan

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyeartermstopackagedirectloan-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Unsupported Dependent

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearunsupporteddependent-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}